vcPackFolder

vcPackFolder allows you to pack files with a VCMX file and extract them. Files are contained in a folder that is mapped to a layout or component. Generally, you would map a temporary folder that you want to save with a VCMX file, and then extract the folder and its contents when you open the VCMX file. This allows you to share a layout or component that contains other files, for example a CSV file of robot position data.

See in: Overview

Module: vcCore

Parent: vcObject

Children -

Referenced by: vcComponent.PackFolder, vcLayoutPackFolder.PackFolder, vcRrsRobotController.RobotDataPackFolder

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
PackFolderLocalPath	String	R	Gets the file path of mapped folder.
State	vcPackFolderState	R	Gets the state of mapped folder. See: 'vcPackFolderState' for available values.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
mapFolder	None	String uri	Maps a temporary folder generated by the application or an existing folder at the given uri which must be a file path. See more Files will be packed/extracted at the time of call. Parameters: uri (str): The local folder path or empty string.
remapFolder	None	String uri	Remaps a different folder. This will not override the other folder until you save the VCMX file. See more Files in the other folder will also not be deleted unless they were contained in a temporary folder generated by the application. Parameters: uri (str): The local folder path. Exceptions: ValueError: If the given path is empty.
rollbackFolder	None	None	Removes mapping to folder. Generally, this is used before you map a different folder.